feat(openapi): generate merged spec #497
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest Buf updates on your PR. Results from workflow Buf CI / buf (pull_request).
|
jvallesm
force-pushed
the
jvalles/ins-6510-merge-all-public-endpoints-into-single-openapi-file
branch
2 times, most recently
from
13ac045 to
85eb0ab
Compare
jvallesm
requested review from
donch1989,
heiruwu,
pinglin and
xiaofei-du
as code owners
jvallesm
force-pushed
the
jvalles/ins-6510-merge-all-public-endpoints-into-single-openapi-file
branch
6 times, most recently
from
68a8f20 to
2c957ee
Compare
It's an issue that doesn't happen with the newer versions of `grpc-gateway`, so the generated file doesn't change with or without this command.
Using a nested path parameter produced lint errors in the OpenAPI spec:
- Reference wasn't detected in the request object
- `/v1beta/namespaces/{}/connections[/{}]` wasn't a unique path.
jvallesm
force-pushed
the
jvalles/ins-6510-merge-all-public-endpoints-into-single-openapi-file
branch
from
2c957ee to
d33c50d
Compare
jvallesm
force-pushed
the
jvalles/ins-6510-merge-all-public-endpoints-into-single-openapi-file
branch
from
d33c50d to
9299bbc
Compare
triggered by commit: e43030a
jvallesm
deleted the
jvalles/ins-6510-merge-all-public-endpoints-into-single-openapi-file
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because
OpenAPI definition.
a single service (
api-gateway). Headers represent that service'sinterface rather than the backend ones.
This commit
This adds some duplication in the configuration (
/<service>/openapi.proto.templand/openapiv2/conf.proto).We need to decide if we want to use the merged OpenAPI instead (we'll lose the service as a category and the endpoints will be only grouped by tags.
collisions.
readme.com, we might consider group endpoints by service or
merge some tags ([User, Organization] -> Namespace).